-
Notifications
You must be signed in to change notification settings - Fork 411
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(js): ♻️ Adding references to helia.io + Old js-ipfs stuff. #1694
Conversation
Signed-off-by: Nishant Arora <[email protected]>
docs/reference/js/api.md
Outdated
|
||
[JS-IPFS](https://github.com/ipfs/js-ipfs) was the first IPFS implementation in JavaScript. It still exists in its current form, but is no longer actively maintained. Please read [this post](https://github.com/ipfs/js-ipfs/issues/4336) to understand why this was done. For newer projects we recommend using [Helia](#helia) instead. | ||
|
||
### Examples | ||
|
||
JS-IPFS examples can be found [here](https://github.com/ipfs-examples/js-ipfs-examples). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we explicitly removed mentions of js-ipfs and don't want to re-add them
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. We shouldn't discuss js-ipfs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed mentions in b9150b3
docs/reference/js/api.md
Outdated
|
||
[JS-IPFS](https://github.com/ipfs/js-ipfs) was the first IPFS implementation in JavaScript. It still exists in its current form, but is no longer actively maintained. Please read [this post](https://github.com/ipfs/js-ipfs/issues/4336) to understand why this was done. For newer projects we recommend using [Helia](#helia) instead. | ||
|
||
### Examples | ||
|
||
JS-IPFS examples can be found [here](https://github.com/ipfs-examples/js-ipfs-examples). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. We shouldn't discuss js-ipfs.
@@ -5,10 +5,20 @@ description: Developer resources for working in JavaScript with IPFS, the InterP | |||
|
|||
# IPFS in JavaScript |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page should discuss the various ways one can "interface with IPFS" with JavaScript. Helia isn't the only way. At the minimum, we should add the js-kubo-rpc-client.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added mention in b9150b3
Made an update that removes js-ipfs references, reorgs the page a bit, and adds js-kubo-rpc-client info. 3 callouts:
|
docs/reference/js/api.md
Outdated
|
||
First, [install the client using `npm` or as a browser script tag](https://github.com/ipfs/js-kubo-rpc-client#install). Then, consult the [command reference](https://github.com/ipfs/js-kubo-rpc-client#usage) for usage information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We also should mention that one needs to install Kubo. This can be done with https://www.npmjs.com/package/kubo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added.
Merging this in since it looks like the various comments were addressed. LMK if we need to reopen |
Describe your changes
Adding reference to helia.io.
Files changed
docs/reference/js/api.md
What issue(s) does this address?
Does this update depend on any other PRs?
Checklist before requesting a review
Checklist before merging